/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cn.cloud.all.security.oauth2.client;

import cn.cloud.all.security.core.Authentication;
import reactor.core.publisher.Mono;

/**
 * Implementations of this interface are responsible for the management
 * of {@link OAuth2AuthorizedClient Authorized Client(s)}, which provide the purpose
 * of associating an {@link OAuth2AuthorizedClient#getAccessToken() Access Token} credential
 * to a {@link OAuth2AuthorizedClient#getClientRegistration() Client} and Resource Owner,
 * who is the {@link OAuth2AuthorizedClient#getPrincipalName() Principal}
 * that originally granted the authorization.
 */
public interface ReactiveOAuth2AuthorizedClientService {

    /**
     * Returns the {@link OAuth2AuthorizedClient} associated to the
     * provided client registration identifier and End-User's {@code Principal} name
     * or {@code null} if not available.
     *
     * @param clientRegistrationId the identifier for the client's registration
     * @param principalName        the name of the End-User {@code Principal} (Resource Owner)
     * @param <T>                  a type of OAuth2AuthorizedClient
     * @return the {@link OAuth2AuthorizedClient} or {@code null} if not available
     */
    <T extends OAuth2AuthorizedClient> Mono<T> loadAuthorizedClient(String clientRegistrationId,
                                                                    String principalName);

    /**
     * Saves the {@link OAuth2AuthorizedClient} associating it to
     * the provided End-User {@link Authentication} (Resource Owner).
     *
     * @param authorizedClient the authorized client
     * @param principal        the End-User {@link Authentication} (Resource Owner)
     */
    Mono<Void> saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal);

    /**
     * Removes the {@link OAuth2AuthorizedClient} associated to the
     * provided client registration identifier and End-User's {@code Principal} name.
     *
     * @param clientRegistrationId the identifier for the client's registration
     * @param principalName        the name of the End-User {@code Principal} (Resource Owner)
     */
    Mono<Void> removeAuthorizedClient(String clientRegistrationId, String principalName);

}
